Sendbird UIKit/com.sendbird.uikit.vm/UserViewModel

UserViewModel

abstract class UserViewModel<T> : BaseViewModel, OnPagedDataLoader<T>

ViewModel preparing and managing data related with the list of users since 3.0.0

Constructors

UserViewModel

open fun UserViewModel(@NonNull channelUrl: String)

Constructor

UserViewModel

open fun UserViewModel(@NonNull channelUrl: String, @Nullable queryHandler: PagedQueryHandler<T>)

Constructor

Functions

addOperator

open fun addOperator(@NonNull userId: String, @Nullable handler: OnCompleteHandler)

Adds user with userId as operators.

addOperators

open fun addOperators(@NonNull userIds: List<String>, @Nullable handler: OnCompleteHandler)

Adds users with id in userIds as operators.

authenticate

open fun authenticate(@NonNull handler: AuthenticateHandler)

Tries to connect Sendbird Server and retrieve a channel instance.

banUser

open fun banUser(@NonNull userId: String, @Nullable handler: OnCompleteHandler)

Bans the user with userId.

createQueryHandler

@NonNull

protected abstract fun createQueryHandler(@NonNull channelUrl: String): PagedQueryHandler<T>

Create a query handler that is loading paged data.

getChannelDeleted

@NonNull

open fun getChannelDeleted(): LiveData<Boolean>

Returns LiveData that can be observed if the channel has been deleted.

getOperatorUnregistered

@NonNull

open fun getOperatorUnregistered(): LiveData<Boolean>

Returns LiveData that can be observed if the current user has been unregistered from the operator.

getStatusFrame

@NonNull

open fun getStatusFrame(): LiveData<StatusFrameView.Status>

Returns LiveData that can be observed for the status of the result of fetching the user list.

getUserList

@NonNull

open fun getUserList(): LiveData<List<T>>

Returns LiveData that can be observed for the list of users.

hasNext

open fun hasNext(): Boolean

Determine whether the data on the next page exists.

hasPrevious

open fun hasPrevious(): Boolean

Returns false as the user list do not support to load for the previous by default.

inviteUser

open fun inviteUser(@NonNull userIds: List<String>, @Nullable handler: OnCompleteHandler)

Invites users with id in userIds to the channel.

loadInitial

open fun loadInitial(): Boolean

Requests the list of Users for the first time.

loadNext

@NonNull

open fun loadNext(): List<T>

Requests the list of Users.

loadPrevious

@NonNull

open fun loadPrevious(): List<T>

Returns the empty list as the user list do not support to load for the previous by default.

muteUser

open fun muteUser(@NonNull userId: String, @Nullable handler: OnCompleteHandler)

Mutes the user with userId.

onCleared

protected open fun onCleared()

removeOperator

open fun removeOperator(@NonNull userId: String, @Nullable handler: OnCompleteHandler)

Dismisses operator with userId.

unbanUser

open fun unbanUser(@NonNull userId: String, @Nullable handler: OnCompleteHandler)

Unbans the user with userId.

unmuteUser

open fun unmuteUser(@NonNull userId: String, @Nullable handler: OnCompleteHandler)

Unmutes the user with userId.

Properties

channel

@Nullable

@get:Nullable

open val channel: GroupChannel

channelUrl

@NonNull

@get:NonNull

val channelUrl: String

Inheritors

BannedUserListViewModel

CreateChannelViewModel

InviteUserViewModel

MemberListViewModel

MutedMemberListViewModel

OperatorListViewModel

RegisterOperatorViewModel